/**
 *    Copyright (C) 2025-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#pragma once

#include "mongo/db/exec/agg/exec_pipeline.h"
#include "mongo/db/pipeline/document_source.h"
#include "mongo/util/modules.h"

#include <memory>

namespace mongo {

class Pipeline;

namespace exec::agg {

/**
 * Builds and returns a query execution pipeline from the given document source pipeline.
 * Expects that the document source is 'frozen' for modifications.
 * Raises a tassert when called with an empty 'pipeline' object, i.e. a pipeline that contains 0
 * 'DocumentSource's, because empty pipelines cannot be executed.
 * TODO SERVER-105562: Return the resulting pipeline by value.
 * TODO SERVER-112776: Remove 'data_movement' dependency on this function.
 * TODO SERVER-112777: Remove 'atlas_streams' dependency on this function.
 */
MONGO_MOD_NEEDS_REPLACEMENT std::unique_ptr<exec::agg::Pipeline> buildPipeline(
    const mongo::Pipeline& pipeline);

}  // namespace exec::agg
}  // namespace mongo
